/*
 *    Copyright 2010 Vanessa Williams
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

/*
 * FASTASequenceIterator.java
 * Created on Feb 13, 2010
 */

package bioformatica.sequence;

import bioformatica.util.CloseableIterator;

/**
 * Iterator over FASTASequence. next() returns Byte.
 */
public class FASTASequenceIterator implements CloseableIterator<Byte> {

    private FASTASequence fastaSequence;
    private boolean open;

    /**
     * Constructor
     * @param fastaSequence FASTA sequence over which to iterate
     */
    public FASTASequenceIterator(FASTASequence fastaSequence) {
        this.fastaSequence = fastaSequence;
        this.open = false;
    }

    /**
     * {@inheritDoc}
     * @return
     */
    public boolean hasNext() {
        return fastaSequence.hasNext();
    }

    /**
     * {@inheritDoc}
     */
    public Byte next() {
        return fastaSequence.next();
    }

    /**
     * Not implemented.
     */
    public void remove() {
        throw new UnsupportedOperationException("Remove operation not supported on FASTA sequence files.");    
    }

    public void close() {
        this.open = false;
    }

    public boolean isOpen() {
        return open;
    }

    public void open() {
        this.open = true;
    }
}
